<html>

<h1>Solr Search</h1>
<p>The Solr Search application, which is based on  <a href="http://lucene.apache.org/solr/">Apache Solr</a>, allows you to perform keyword searches across Hadoop data. A wizard lets you style the result snippets, specify facets to group the results, sort the results, and highlight result fields.</p>

                <h2 class="subhead"><a href="http://gethue.com/new-search-feature-graphical-facets">New Search feature: Graphical facets</a></h2>


                <p>
                    <p>This feature lets you search interactively:</p>
<p><iframe frameborder="0" height="495" src="http://player.vimeo.com/video/78887745" width="900"></iframe></p>
<p>As usual feel free to comment on the <a href="https://groups.google.com/a/cloudera.org/group/hue-user/">hue-user</a> list or <a href="https://twitter.com/gethue">@gethue</a>!</p>
                </p>


<h2>Solr Search Installation and Configuration</h2>

<p>Solr Search is one of the applications installed as part of Hue. For information about installing and configuring Hue, see the Hue Installation
manual.</p>
<h2>Starting  Solr Search</h2>
<p>Click the <strong> Solr Search</strong> icon
(<img alt="image" src="/static/search/art/icon_search_24.png" />) in the navigation bar at the top of
the Hue browser page. <strong>Solr Search</strong> opens to the  <a href="#collectionManager">Collection Manager</a>. If there are no collections, the <a href="#importCollection">Import Collections and Cores</a> dialog displays.</p>
<p><a id="collectionManager"></a></p>
<h2>Collection Manager</h2>
<p>In Collection Manager you import, copy, and delete <a href="http://wiki.apache.org/solr/SolrCloud#A_little_about_SolrCores_and_Collections">collections</a>.</p>
<h3>Displaying the Collection Manager</h3>
<p>When you start Solr Search, the Collection Manager displays. You navigate to the Collection Manager by clicking <strong>Collection manager</strong> in the Search page or the Template Editor.</p>
<h3>Filtering Collections</h3>
<p>When you type in the Filter field, the list of collections is dynamically filtered to display only those rows
containing text that matches the specified substring.</p>
<p><a id="importCollection"></a></p>
<h3>Importing Collections</h3>
<ol>
<li>If there are existing collections, click the <i class="fa fa-plus-sign"></i> <strong>Import</strong> button at the top right. The Import Collections and Cores dialog displays.</li>
<li>Check the checkboxes next to the collections to import.</li>
<li>Click <strong>Import Selected</strong>. The collection is added to the Collection Manager.</li>
</ol>
<h3>Editing Collection Properties</h3>
<ol>
<li>In the Collection Manager, click a collection.</li>
<li>In the <strong>COLLECTION</strong> area on the left, click <strong>Properties</strong>.</li>
<li>Edit a property and click <strong>Save</strong>.</li>
</ol>
<h3>Searching a Collection</h3>
<ol>
<li>In the Collection Manager, click <strong>Search page</strong> or click <strong>Search it</strong> in the Collection area on the left. The Search page displays.</li>
<li>Select a collection from the <strong>Search in</strong> drop-down list.</li>
<li>Type a search string in the <strong>Search...</strong> text box.</li>
<li>
<p>Press <strong>Enter</strong> or click the <i class="fa fa-search"></i>  icon.</p>
</li>
<li>
<p>If you have defined <a href="#facets">facets</a>, click a facet to display only those results in the group defined by the facet.</p>
</li>
<li>If you have defined <a href="#sorting">sorting fields</a>, select from the <strong>Sort by</strong> drop-down list to sort the results.</li>
<li>Click 'X' to clear the search string.</li>
</ol>
<h2>Styling Search Results</h2>
<p>Do one of the following:</p>
<ul>
<li>In the Collection Manager, click a collection.</li>
<li>In the Search page, select a collection from the <strong>Search in</strong> drop-down list and click <strong> Customize this collection</strong>.  The Template Editor displays.</li>
</ul>
<h3>Template Editor</h3>
<p>The Template Editor provides four features:</p>
<ul>
<li><a href="#snippetEditor">Snippet editor</a> - Specify the layout of the search result snippet, which fields appear in the snippet, and style the results.</li>
<li><a href="#facetEditor">Facet editor</a> - Define buckets in which to group results.</li>
<li><a href="#sortEditor">Sort editor</a> - Specify on which fields and order the results are sorted. </li>
<li><a href="#highlightingEditor">Highlighting editor</a> - Enable highlighting of search fields. </li>
</ul>
<p><a id="snippetEditor"></a></p>
<h4>Snippet Editor</h4>
<ol>
<li>In the Snippet Editor, click a tab to choose the method for editing the search snippet fields and styling:</li>
<li>
<ul>
<li><strong>Visual editor</strong> - Click <img alt="image" src="images/layoutChooser.png" /> to choose an overall layout for the snippet.</li>
</ul>
</li>
<li>
<ul>
<li>
<ul>
<li>Select the fields and functions from the drop-down lists on the right and click <img alt="image" src="images/add.png" />. </li>
</ul>
</li>
</ul>
</li>
<li>
<ul>
<li>
<ul>
<li>Select fields, right-click, and select <strong>Cut</strong> and <strong>Paste</strong> to place the fields on the canvas. </li>
</ul>
</li>
</ul>
</li>
<li>
<ul>
<li>
<ul>
<li>Select fields and apply styling using the buttons on top.</li>
</ul>
</li>
</ul>
</li>
<li>
<ul>
<li><strong>Source</strong> - </li>
</ul>
</li>
<li>
<ul>
<li>
<ul>
<li>Select the data fields and functions from the drop-down lists on the right.</li>
</ul>
</li>
</ul>
</li>
<li>
<ul>
<li>
<ul>
<li>Specify layout and styling using HTML tags.</li>
</ul>
</li>
</ul>
</li>
<li>
<ul>
<li><strong>Preview</strong> - Preview the snippet.</li>
</ul>
</li>
<li>
<ul>
<li><strong>Advanced</strong> - Specify styles for CSS classes specified in the Source tab.</li>
</ul>
</li>
<li>Click <strong>Save</strong>.</li>
</ol>
<p><a id="facetEditor"></a></p>
<h4>Facet Editor</h4>
<p>By default, faceting  search result fields is disabled. Click <strong>Enabled</strong> to enable faceting.</p>
<ol>
<li>In the Template Editor, click <strong>2. Facets</strong>. You can move between the facet tabs by clicking each <strong>Step</strong> tab, or by clicking <strong>Back</strong> and <strong>Next</strong>.</li>
<li>In the General tab, specify </li>
<li>
<ul>
<li><strong>Limit</strong> - the maximum number of values for each facet.</li>
</ul>
</li>
<li>
<ul>
<li><strong>Mincount</strong> - the minimum number of search results that fall into a group for the facet to display on the Search page.</li>
</ul>
</li>
<li>In the Field, Range, and Date Facet tabs,  specify the facet properties and click <img alt="image" src="images/add.png" /> <strong>Add</strong>.</li>
<li>In the Facets Order tab, drag and drop the facet to specify the order in they appear in the Search page.</li>
<li>Click <strong>Save</strong>. When you display the Search page, the facets display on the left.</li>
</ol>
<p><a id="sortEditor"></a></p>
<h4>Sorting Editor</h4>
<p>By default, sorting on search result fields is disabled. Click <strong>Enabled</strong> to enable sorting.</p>
<ol>
<li>In the Template Editor, click <strong>3. Sorting</strong>. </li>
<li>In the Field drop-down, select a field. Optionally specify a label for the field. </li>
<li>The default order is ascending. Click the arrows to change the order.</li>
<li>Click  <img alt="image" src="images/add.png" /> <strong>Add</strong>.</li>
<li>Click <strong>Save</strong>. When you display search results, the results are sorted by the fields in the order that  they appear left to right. </li>
</ol>
<p><a id="highlightingEditor"></a></p>
<h4>Highlighting Editor</h4>
<p>By default,highlighting search result fields is disabled. Click <strong>Enabled</strong> to enable highlighting.</p>
<ol>
<li>In the Template Editor, click <strong>3. Highlighting</strong>. </li>
<li>Select the fields to be highlighted.</li>
<li>Click <strong>Save</strong>. When you display search results, the selected fields are displayed with the style of the <strong>em</strong> class defined in the Advanced tab of the <a href="#snippetEditor">Snippet editor</a>. </li>
</ol>

</html>
